improve docs around usage of extracted calibration info #1214
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1214 +/- ##
========================================
+ Coverage 3.59% 3.78% +0.19%
========================================
Files 13 395 +382
Lines 947 43457 +42510
Branches 152 6397 +6245
========================================
+ Hits 34 1645 +1611
- Misses 843 41669 +40826
- Partials 70 143 +73
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
urfeex
reviewed
Dec 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added to / modified documentation to make it more clear how to utilize extracted calibration information, and how to verify that the information is being utilized. Also clarified that the robot must be on to extract calibration info.
I added a description of the parameter-passing method, but not the "create your own description package and use that" method. That seemed a little too in-depth and unnecessary for the getting started documentation, when the parameter method will work for most cases. But if I'm missing something, maybe we want to describe the second method as well.
Related issues: #799